home *** CD-ROM | disk | FTP | other *** search
/ Freelog 15 / FREELOG 15.ISO / WebMaster / Perl / PERL5106.ZIP / perl5 / Lib / Win32 / mutex.pm < prev    next >
Encoding:
Perl POD Document  |  1996-01-17  |  1.2 KB  |  58 lines
  1. package Win32::Mutex;
  2. use Win32::IPC;
  3. require Exporter;
  4. require DynaLoader;
  5. require AutoLoader;
  6.  
  7. @ISA = qw(Exporter DynaLoader Win32::IPC);
  8.  
  9. =head1 NAME
  10.  
  11. Win32::Mutex - create mutex objects in perl.
  12.  
  13. =head1 SYNOPSIS
  14.  
  15.     use Win32::Mutex;
  16.  
  17.     Win32::Mutex::Create($MutObj,$Initial,$Name);
  18.     $MutObj->Wait(INFINITE);
  19.  
  20. =head1 DESCRIPTION
  21. This module creates access to the Win32 mutex objects.  The Wait and
  22. WaitForMultipleObjects calls are inherited from the Win32::IPC module.
  23.  
  24. =head1 METHODS AND CONSTRUCTORS
  25.  
  26.     Create($MutObj,$Initial,$Name)
  27.         Creates a mutex object in $MutObj.
  28.  
  29.         $Initial    Flags to decide initial ownership.(TRUE = I own it).
  30.         $Name        String to name the mutex.
  31.  
  32.     Open($MutObj,$Name)
  33.         Create a mutex object from an already created mutex
  34.  
  35.         $MutObj        Container for mutex object.
  36.         $Name        name of already created mutex.
  37.  
  38.     $MutObj->Release();
  39.         Release ownership of a mutex.
  40.  
  41.     $MutObj->Wait($Timeout)
  42.         wait for ownership of a mutex.
  43.  
  44.         $Timeout    amount of time you will wait.forever = INFINITE;
  45.  
  46.  
  47.  
  48. =cut
  49.  
  50. bootstrap Win32::Mutex;
  51.  
  52. # Preloaded methods go here.
  53.  
  54. # Autoload methods go after __END__, and are processed by the autosplit program.
  55.  
  56. 1;
  57. __END__
  58.